\section{Login\-Form Class Reference}
\label{class_login_form}\index{Login\-Form@{Login\-Form}}
Inheritance diagram for Login\-Form\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_login_form}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf rules} ()
\item 
{\bf attribute\-Labels} ()
\item 
{\bf authenticate} (\$attribute, \$params)
\item 
{\bf login} ()
\end{DoxyCompactItemize}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
{\bfseries \$username}\label{class_login_form_a0eb82aa5f81cf845de4b36cd653c42cf}

\item 
{\bfseries \$password}\label{class_login_form_a607686ef9f99ea7c42f4f3dd3dbb2b0d}

\item 
{\bfseries \$remember\-Me}\label{class_login_form_ad9e6993ef3c93c464ec55f7d7e5d1ac9}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\doxyref{Login\-Form}{p.}{class_login_form} class. \doxyref{Login\-Form}{p.}{class_login_form} is the data structure for keeping user login form data. It is used by the 'login' action of '\doxyref{Site\-Controller}{p.}{class_site_controller}'. 

\subsection{Member Function Documentation}
\index{Login\-Form@{Login\-Form}!attribute\-Labels@{attribute\-Labels}}
\index{attribute\-Labels@{attribute\-Labels}!LoginForm@{Login\-Form}}
\subsubsection[{attribute\-Labels}]{\setlength{\rightskip}{0pt plus 5cm}attribute\-Labels (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_login_form_aae54d2938df6eac42a9a9020a64ae31b}
Declares attribute labels. \index{Login\-Form@{Login\-Form}!authenticate@{authenticate}}
\index{authenticate@{authenticate}!LoginForm@{Login\-Form}}
\subsubsection[{authenticate}]{\setlength{\rightskip}{0pt plus 5cm}authenticate (
\begin{DoxyParamCaption}
\item[{}]{\$attribute, }
\item[{}]{\$params}
\end{DoxyParamCaption}
)}\label{class_login_form_a836358929415996942d69a75f7547b5c}
Authenticates the password. This is the 'authenticate' validator as declared in \doxyref{rules()}{p.}{class_login_form_a17dba92d96b9dd48c62f3ede3eef94d4}. \index{Login\-Form@{Login\-Form}!login@{login}}
\index{login@{login}!LoginForm@{Login\-Form}}
\subsubsection[{login}]{\setlength{\rightskip}{0pt plus 5cm}login (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_login_form_aa311da27ba5706f5710cea7706c8eae1}
Logs in the user using the given username and password in the model. \begin{DoxyReturn}{Returns}
boolean whether login is successful 
\end{DoxyReturn}
\index{Login\-Form@{Login\-Form}!rules@{rules}}
\index{rules@{rules}!LoginForm@{Login\-Form}}
\subsubsection[{rules}]{\setlength{\rightskip}{0pt plus 5cm}rules (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_login_form_a17dba92d96b9dd48c62f3ede3eef94d4}
Declares the validation rules. The rules state that username and password are required, and password needs to be authenticated. 

The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
protected/models/Login\-Form.\-php\end{DoxyCompactItemize}
